Class FrameRelayProcessImpl

All Implemented Interfaces:
IPCObject, FrameRelayProcess, PortKeepAliveProcess, Process

public class FrameRelayProcessImpl extends PortKeepAliveProcessImpl implements FrameRelayProcess
Information provided by the PKI file:

    \class FrameRelayProcess
    
    \brief FrameRelayProcess handles and manipulates the Frame Relay process.
    
    \example network().getDevice("Router0").getPort("Serial0/0/0").getKeepAliveProcess()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • setLmiType

      public void setLmiType(LMIType lmiType)
      Information provided by the PKI file:
      
          \brief Sets the LMI type for this Frame Relay process.
          
          \param lmiType,     the LMI type.
          LMI types:  eLmiAnsi = 0,
          eLmiCisco = 1,
          eLmiQ933a = 2
          
              
      Specified by:
      setLmiType in interface FrameRelayProcess
      Parameters:
      lmiType - Takes in a parameter of lmiType
    • setEncapType

      public void setEncapType(FrameRelayEncapType encapType)
      Information provided by the PKI file:
      
          \brief Sets the encapsulation type for this Frame Relay process.
          
          \param encapType,   the encapsulation type.
          Encapsulation types:        eFrameRelayEncapCisco = 0,
          eFrameRelayEncapIetf = 1,
          eFrameRelayEncapDefault = 2
          
              
      Specified by:
      setEncapType in interface FrameRelayProcess
      Parameters:
      encapType - Takes in a parameter of encapType
    • getEncapType

      public FrameRelayEncapType getEncapType()
      Information provided by the PKI file:
      
          \brief Returns the encapsulation type of this Frame Relay process.
          
          \return FrameRelayEncapType,        the encapsulation type of this Frame Relay process.
          Encapsulation types:        eFrameRelayEncapCisco = 0,
          eFrameRelayEncapIetf = 1,
          eFrameRelayEncapDefault = 2
          
              
      Specified by:
      getEncapType in interface FrameRelayProcess
      Returns:
      FrameRelayEncapType Returns a FrameRelayEncapType
    • getLmiType

      public LMIType getLmiType()
      Information provided by the PKI file:
      
          \brief Returns the encapsulation type of this Frame Relay process.
          
          \return LmiType,    the LMI type of this Frame Relay process.
          LMI types:  eLmiAnsi = 0,
          eLmiCisco = 1,
          eLmiQ933a = 2
          
              
      Specified by:
      getLmiType in interface FrameRelayProcess
      Returns:
      LMIType Returns a LMIType
    • addMapEntry

      public boolean addMapEntry(IPAddress ipAddress, int dlci, boolean bBroadcast, FrameRelayEncapType encapType, String portName)
      Information provided by the PKI file:
      
          \brief Adds a map entry to the specified port.
          
          \param ipAddress, the IP address to map.
          \param dlci, the DLCI number.
          \param bBroadcast, true forwards broadcasts to this address, false does not forward broadcasts.
          \param encapType,   the encapsulation type of this Frame Relay process.
          Encapsulation types:        eFrameRelayEncapCisco = 0,
          eFrameRelayEncapIetf = 1,
          eFrameRelayEncapDefault = 2
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      addMapEntry in interface FrameRelayProcess
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
      dlci - Takes in a parameter of dlci
      bBroadcast - Takes in a parameter of bBroadcast
      encapType - Takes in a parameter of encapType
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • addIntDlciEntry

      public boolean addIntDlciEntry(String portName, int dlci)
      Information provided by the PKI file:
      
          \brief Adds a interface-DLCI entry the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param dlci, the DLCI number.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      addIntDlciEntry in interface FrameRelayProcess
      Parameters:
      portName - Takes in a parameter of portName
      dlci - Takes in a parameter of dlci
      Returns:
      boolean Returns a boolean
    • deleteMapEntry

      public boolean deleteMapEntry(String portName, IPAddress ipAddress)
      Information provided by the PKI file:
      
          \brief Removes the map entry from the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param ipAddress, the IP address of the map.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      deleteMapEntry in interface FrameRelayProcess
      Parameters:
      portName - Takes in a parameter of portName
      ipAddress - Takes in a parameter of ipAddress
      Returns:
      boolean Returns a boolean
    • deleteIntDlciEntry

      public boolean deleteIntDlciEntry(String portName, int dlci)
      Information provided by the PKI file:
      
          \brief Removes the interface-DLCI entry from the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param dlci, the DLCI number.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      deleteIntDlciEntry in interface FrameRelayProcess
      Parameters:
      portName - Takes in a parameter of portName
      dlci - Takes in a parameter of dlci
      Returns:
      boolean Returns a boolean
    • getMapEntryAt

      public FrameRelayMapEntry getMapEntryAt(int index, String portName)
      Information provided by the PKI file:
      
          \brief Returns the map entry at the specified index on the specified port.
          
          \param index, the index of the map entry of interest.
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return FrameRelayMapEntry, the FrameRelayMapEntry object at the specified index on the specified port.
          
              
      Specified by:
      getMapEntryAt in interface FrameRelayProcess
      Parameters:
      index - Takes in a parameter of index
      portName - Takes in a parameter of portName
      Returns:
      FrameRelayMapEntry Returns a FrameRelayMapEntry
    • getIntDlciEntryAt

      public Short getIntDlciEntryAt(int index, String portName)
      Information provided by the PKI file:
      
          \brief Returns the interface-DLCI number at the specified index on the specified port.
          
          \param index, the index of the interface-DLCI of interest.
          \param portName             portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return short, the interface-DLCI number at the specified index on the specified port.
          
              
      Specified by:
      getIntDlciEntryAt in interface FrameRelayProcess
      Parameters:
      index - Takes in a parameter of index
      portName - Takes in a parameter of portName
      Returns:
      Short Returns a Short
    • getLmiDlciEntryAt

      public Short getLmiDlciEntryAt(int index)
      Information provided by the PKI file:
      
          \brief Returns LMI DLCI at the specified index.
          
          \param index, the index of the LMI DLCI of interest.
          
          \return short, the LMI DLCI at the specified index.
          
              
      Specified by:
      getLmiDlciEntryAt in interface FrameRelayProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      Short Returns a Short
    • getLmiDlciStatusEntryAt

      public boolean getLmiDlciStatusEntryAt(int index)
      Information provided by the PKI file:
      
          \brief Returns true if the LMI DLCI at the specified index is active, otherwise false.
          
          \param index, the index of the LMI DLCI of interest.
          
          \return bool, true if the LMI DLCI at the specified index is active, otherwise false.
          
              
      Specified by:
      getLmiDlciStatusEntryAt in interface FrameRelayProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      boolean Returns a boolean
    • getMapEntryCount

      public int getMapEntryCount(String portName)
      Information provided by the PKI file:
      
          \brief Returns the number of map entries.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return int, the number of map entries.
          
              
      Specified by:
      getMapEntryCount in interface FrameRelayProcess
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      int Returns a int
    • getIntDlciEntryCount

      public int getIntDlciEntryCount(String portName)
      Information provided by the PKI file:
      
          \brief Returns the number of interface-DLCI entries.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return int, the number of interface-DLCI entries.
          
              
      Specified by:
      getIntDlciEntryCount in interface FrameRelayProcess
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      int Returns a int
    • getLmiDlciEntryCount

      public int getLmiDlciEntryCount()
      Information provided by the PKI file:
      
          \brief Returns the number of LMI DLCI entries.
          
          \return int, the number of LMI DLCI entries.
          
              
      Specified by:
      getLmiDlciEntryCount in interface FrameRelayProcess
      Returns:
      int Returns a int
    • getIntDlciToPort

      public Port getIntDlciToPort(int dlci)
      Information provided by the PKI file:
      
          \brief Returns the port of the specified interface-DLCI.
          
          \param dlci, the interface-DLCI of interest.
          
          \return Port, the Port object of the specified interface-DLCI.
          
              
      Specified by:
      getIntDlciToPort in interface FrameRelayProcess
      Parameters:
      dlci - Takes in a parameter of dlci
      Returns:
      Port Returns a Port
    • clearInvArpEntries

      public void clearInvArpEntries()
      Information provided by the PKI file:
      
          \brief Clears the inverse ARP entries.
          
              
      Specified by:
      clearInvArpEntries in interface FrameRelayProcess
    • getDlciTable

      public DLCITable getDlciTable()
      Information provided by the PKI file:
      
          \brief Returns the DLCI table.
          
          \return DlciTable, the DlciTable object.
          
              
      Specified by:
      getDlciTable in interface FrameRelayProcess
      Returns:
      DLCITable Returns a DLCITable